Skip to content

docs: refresh the README for 1.1.0, and give the product its own mark - #80

Merged
westerosweb merged 3 commits into
mainfrom
docs/readme-refresh
Aug 30, 2026
Merged

docs: refresh the README for 1.1.0, and give the product its own mark#80
westerosweb merged 3 commits into
mainfrom
docs/readme-refresh

Conversation

@westerosweb

Copy link
Copy Markdown
Contributor

The README still described the app as of 1.0.1. Nothing from 1.1.0 was in it, and its
header carried the Bitwize wordmark under alt="Logue" — the product had no mark of its
own on the page at all.

Header

A single composite banner: Bitwize.ai at the left edge, the Logue wordmark at the right,
with a <picture> swap to white silhouettes on dark.

The obvious markup for this does not work. GitHub's stylesheet sets
display: block; width: max-content on markdown tables, which overrides width="100%"
and collapses percentage-width cells, so a two-cell table renders both logos shrink-wrapped
at the left rather than justified. style attributes are stripped, so there is no CSS
escape either. Compositing puts the justification in the image's own geometry, so it holds
at every viewport width and renders the same outside GitHub — npm, mirrors, editor previews.

The banner is built at 2x (1800×140) and displayed at width="100%" to stay crisp at
GitHub's content width. The Logue marks are rendered from the app's own
Logue/Resources/LogueLogo*.svg, so they cannot drift from what ships.

The centred # Logue heading is gone — the wordmark carries the name, and GitHub already
prints the repository name above the README.

Trade-off: the banner is one link rather than two independently clickable logos, and it
needs recompositing if either mark changes. A three-cell table with a fixed-width transparent
spacer would keep both links, but its width is in pixels, so it puts a horizontal scrollbar
on the header in a narrow window.

Screenshots

All taken from the current app. The home shot is the merged Home/Ask surface rather than the
old dashboard, and the four existing images are refreshed. Ask Logue, Tasks and the Chrome
extension are new, so the features written in below have something to show.

Twelve images now total 2.4 MB, against five at 2.2 MB before — PNG8 without dithering, which
UI screenshots quantise into cleanly.

Features

Restructured into eight sections and brought up to 1.1.0:

  • One Place to Start — Home and Ask Logue as a single landing surface
  • Ask Logue — the island running the same agent as the main window, and the tools it can reach
  • Logue in Your Browser — the Chrome extension and the loopback bridge it talks to
  • Beyond the App Window — inline assistant, Command Center, menu bar companion
  • Tasks & Action Items — split out of the old "Search, Tasks & Discovery"
  • Recording resilience, vault import, and the route-by-route Privacy tab folded into their sections

Project Layout gains Logue/Agent/ and Logue/CrossApp/; Install gains the extension.

Two things worth a look in review

.gitignore was dropping new README artwork silently. It excludes docs/* and re-admits
named entries, and docs/images/ was never among them. The images the README already rendered
were tracked from before that rule, so nothing looked wrong — but every new file added there
was invisible to git and would have landed on main as a broken image link. Now re-admitted
alongside docs/specs/.

One unrelated Swift line. CommandCenterChatView+Composer.swift:16 had a
legacy_swiftui_aspect_ratio violation already on main. The pre-push hook lints the whole
repository, so it blocked every push regardless of what the branch touched. scaledToFit() is
the same call with the content mode fixed at .fit, so rendering is unchanged. It is a separate
commit if you would rather it went in on its own.

`.gitignore` excludes `docs/*` and re-admits named entries, and
`docs/images/` was never among them. The images the README already
rendered were tracked from before that rule, so nothing looked wrong —
but every new file added under `docs/images/` was invisible to git and
would have reached `main` as a broken image link.

Re-admit the directory alongside `docs/specs/`.
The README still described the app as of 1.0.1. Nothing from 1.1.0 was
in it, and its header carried the Bitwize wordmark under `alt="Logue"` —
the product had no mark of its own on the page at all.

Header. A single composite banner: Bitwize.ai at the left edge, the Logue
wordmark at the right, with a `<picture>` swap to white silhouettes on
dark. The obvious markup for this does not work — GitHub's stylesheet
sets `display: block; width: max-content` on markdown tables, which
overrides `width="100%"` and collapses percentage-width cells onto the
left. Compositing puts the justification in the image's own geometry, so
it holds at every viewport and renders the same outside GitHub. The
banner is built at 2x and displayed at 100% width to stay crisp. The
centred `# Logue` heading is gone; the wordmark carries the name.

Screenshots. All taken from the current app: the home shot is the merged
Home/Ask surface rather than the old dashboard, and the four existing
images are refreshed. Ask Logue, Tasks and the Chrome extension are new,
so the features written in below have something to show. Twelve images
now total 2.4 MB against five at 2.2 MB before.

Features. Restructured into eight sections and brought up to 1.1.0: Home
and Ask Logue as one surface; the island running the same agent as the
main window; the Chrome extension and the loopback bridge it talks to;
the inline assistant and menu bar companion; Tasks split out of the old
"Search, Tasks & Discovery"; recording resilience; vault import; the
route-by-route Privacy tab. Project Layout gains `Logue/Agent/` and
`Logue/CrossApp/`; Install gains the extension.
`legacy_swiftui_aspect_ratio` fires on `aspectRatio(contentMode:)` with a
constant content mode. The pre-push hook lints the whole repository, so
this one violation on `main` blocked every push regardless of what the
branch touched.

`scaledToFit()` is the same call with the content mode fixed at `.fit`,
so the rendering is unchanged.
@westerosweb
westerosweb requested a review from shanforge as a code owner August 30, 2026 02:46
@westerosweb
westerosweb merged commit fb8c0d5 into main Aug 30, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant